System APIs
Creates a new custom field
| HTTP method | POST |
| URI | https://api.rambase.net/system/dictionary/custom-fields |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 2928, version 4 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Name of the custom field
Maximum value: 40
Input must match the following regular expression pattern: ^([A-Za-z]+[A-Za-z0-9]*)$
>{String}</Name>Description
Description of the custom field
Maximum value: 4500
This field is optional.
>{String}</Description>Object
Required/mandatory field
Object this custom field is belonging to
Applicable domain values can be found here
>{Integer}</Object>DataType
Required/mandatory field
Datatype to use for this custom field
Applicable domain values can be found here
>{Integer}</DataType>HasValueList
True if custom field has a valuelist. The domain values will be of object UDF, and field is the name of the custom field.
Default value: False
This field is optional.
>{Boolean}</HasValueList>Publisher
This field is optional.
>PublisherId
Publisher identifier
Minimum value: 100000
This field is optional.
>{Integer}</PublisherId>Name
Required/mandatory field
Name of the custom field
Maximum value: 40
Input must match the following regular expression pattern: ^([A-Za-z]+[A-Za-z0-9]*)$
": "{String}",Description
Description of the custom field
Maximum value: 4500
This field is optional.
": "{String}",Object
Required/mandatory field
Object this custom field is belonging to
Applicable domain values can be found here
": "{Integer}",DataType
Required/mandatory field
Datatype to use for this custom field
Applicable domain values can be found here
": "{Integer}",HasValueList
True if custom field has a valuelist. The domain values will be of object UDF, and field is the name of the custom field.
Default value: False
This field is optional.
": "{Boolean}",Publisher
This field is optional.
": {PublisherId
Publisher identifier
Minimum value: 100000
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
CustomFieldId
Custom field identifier
>{Integer}</CustomFieldId>Status
Status of the custom field. 4 is active. 9 is deactivated.
Possible domain values can be found here
>{Integer}</Status>Name
Name of the custom field
>{String}</Name>Description
Description of the custom field
>{String}</Description>DataType
Datatype to use for this custom field
Possible domain values can be found here
>{Integer}</DataType>SortingPriority
Priority to sort the field
>{Integer}</SortingPriority>HasValueList
True if custom field has a valuelist. The domain values will be of object UDF, and field is the name of the custom field.
>{Boolean}</HasValueList>Object
Object/archive/context of the DOV
>{String}</Object>Field
Fieldname of the DOV
>{String}</Field>Object
Object this custom field is belonging to
Possible domain values can be found here
>{Integer}</Object>Name
Type of object
>{String}</Name>ShowCustomField
True if custom field should show. Note that field still exists in database, but it is hidden.
>{Boolean}</ShowCustomField>Database
Abbreviation/code to identify the company
>{String}</Database>ShowCustomField
True if custom field should show. Note that field still exists in database, but it is hidden.
>{Boolean}</ShowCustomField>PublisherId
Publisher identifier
>{Integer}</PublisherId>Name
Publisher name
>{String}</Name>Description
Publisher description
>{String}</Description>Prefix
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
>{String}</Prefix>PublisherLink
Publisher reference
>{String}</PublisherLink>CustomFieldId
Custom field identifier
": "{Integer}",Status
Status of the custom field. 4 is active. 9 is deactivated.
Possible domain values can be found here
": "{Integer}",Name
Name of the custom field
": "{String}",Description
Description of the custom field
": "{String}",DataType
Datatype to use for this custom field
Possible domain values can be found here
": "{Integer}",SortingPriority
Priority to sort the field
": "{Integer}",HasValueList
True if custom field has a valuelist. The domain values will be of object UDF, and field is the name of the custom field.
": "{Boolean}",Object
Object/archive/context of the DOV
": "{String}",Field
Fieldname of the DOV
": "{String}"Object
Object this custom field is belonging to
Possible domain values can be found here
": "{Integer}",Name
Type of object
": "{String}",ShowCustomField
True if custom field should show. Note that field still exists in database, but it is hidden.
": "{Boolean}"Database
Abbreviation/code to identify the company
": "{String}",ShowCustomField
True if custom field should show. Note that field still exists in database, but it is hidden.
": "{Boolean}"PublisherId
Publisher identifier
": "{Integer}",Name
Publisher name
": "{String}",Description
Publisher description
": "{String}",Prefix
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
": "{String}",PublisherLink
Publisher reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return: